home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
IRIX Base Documentation 1998 November
/
IRIX 6.5.2 Base Documentation November 1998.img
/
usr
/
share
/
catman
/
p_man
/
cat3
/
Xvc
/
XSGIvcSetPlatformParameter.z
/
XSGIvcSetPlatformParameter
Wrap
Text File
|
1998-10-30
|
9KB
|
199 lines
XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((3333)))) XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((3333))))
NNNNAAAAMMMMEEEE
XSGIvcSetPlatformParameter, XSGIvcQueryPlatformParameter -
Set and query a video parameter unique to a graphics
platform
SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
####iiiinnnncccclllluuuuddddeeee <<<<XXXX11111111////eeeexxxxtttteeeennnnssssiiiioooonnnnssss////XXXXSSSSGGGGIIIIvvvvcccc....hhhh>>>>
vvvvooooiiiidddd XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((DDDDiiiissssppppllllaaaayyyy ****ddddiiiissssppppllllaaaayyyy,,,,
iiiinnnntttt ssssccccrrrreeeeeeeennnn,,,,
iiiinnnntttt cccchhhhaaaannnnnnnneeeellll,,,,
iiiinnnntttt ppppaaaarrrraaaammmmeeeetttteeeerrrrIIIIDDDD,,,,
vvvvooooiiiidddd ****ppppaaaarrrraaaammmmeeeetttteeeerrrrBBBBlllloooocccckkkk,,,,
iiiinnnntttt ssssiiiizzzzeeeeooooffffPPPPaaaarrrraaaammmmeeeetttteeeerrrrBBBBlllloooocccckkkk))))
SSSSttttaaaattttuuuussss XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((DDDDiiiissssppppllllaaaayyyy ****ddddiiiissssppppllllaaaayyyy,,,,
iiiinnnntttt ssssccccrrrreeeeeeeennnn,,,,
iiiinnnntttt cccchhhhaaaannnnnnnneeeellll,,,,
iiiinnnntttt ppppaaaarrrraaaammmmeeeetttteeeerrrrIIIIDDDD,,,,
vvvvooooiiiidddd ****ppppaaaarrrraaaammmmeeeetttteeeerrrrBBBBlllloooocccckkkk,,,,
iiiinnnntttt ssssiiiizzzzeeeeooooffffPPPPaaaarrrraaaammmmeeeetttteeeerrrrBBBBlllloooocccckkkk))))
PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
_d_i_s_p_l_a_y Specifies the connection to the X
server.
_s_c_r_e_e_n Specifies the screen of the X server.
_c_h_a_n_n_e_l Specifies the channel number.
_p_a_r_a_m_e_t_e_r_I_D Specifies which parameter is to be
affected or queried. The parameterID
is unique only to a graphics hardware
platform; the same parameterID may be
used by different hardware platforms
to define different operations.
_p_a_r_a_m_e_t_e_r_B_l_o_c_k A pointer to the parameter block to
be used for the operation.
_s_i_z_e_o_f_P_a_r_a_m_e_t_e_r_B_l_o_c_k The size of the parameter block for
this parameter. The size must match
the size expected for this
parameterID.
DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
Some graphics hardware platforms may offer controls that are
not supported across the entire range of Silicon GraphicsTM
machines, but instead are unique to a certain graphics
hardware platform. In this circumstance, you may affect the
Page 1 (printed 4/30/98)
XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((3333)))) XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((3333))))
control via XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr.
Each hardware platform may optionally offer one or more
platform-specific control parameters. Because these are
unique, these parameters are described in the documentation
accompanying the hardware. Each parameter has a different
parameter block associated with it. The constitution of the
ppppaaaarrrraaaammmmeeeetttteeeerrrrBBBBlllloooocccckkkk is defined by a structure provided by an
included file that accompanies the hardware platform.
You may retrieve the value of the parameter by calling
XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr which fills the parameter block
with the current values of the control parameter.
Note that if you use platform-specific control parameters,
you are affecting a control used on only one platform. The
control is not guaranteed to operate on any other platform
than the one on which the control parameter is designated.
EEEEVVVVEEEENNNNTTTTSSSS
When this control is altered, the server generates a
PlatformParamNotify event.
RRRREEEETTTTUUUURRRRNNNNEEEEDDDD VVVVAAAALLLLUUUUEEEE
XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr returns TRUE if successful,
FALSE upon failure.
Parameter errors are reported via BadValue or BadMatch.
EEEEXXXXAAAAMMMMPPPPLLLLEEEE
In the following contrived example, the graphics hardware
platform called NewPlatform contains the following
definitions to describe a parameter control named IOCUS
whose type is integer. The definitions might be contained
in a file named XSGIvcNewPlatform.h and might include:
#define IOCUS_PARAMETER 5
#define IOCUS_MIN 0
#define IOCUS_MAX 32
typedef struct _iocus {
int value;
} iocus_t;
To use the IOCUS control parameter, call the
XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr function; the following example
sets the value to its lowest value.
Page 2 (printed 4/30/98)
XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((3333)))) XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((3333))))
#include <X11/extensions/XSGIvc.h>
#include <XSGIvcNewPlatform.h>
iocus_t parameterBlock;
int channel = 2;
parameterBlock.value = IOCUS_MIN;
XSGIvcSetPlatformParameter(dpy,
screen,
channel,
IOCUS_PARAMETER,
¶meterBlock,
sizeof(parameterBlock));
SSSSEEEEEEEE AAAALLLLSSSSOOOO
XSGIvc
Page 3 (printed 4/30/98)